XIQS Get Card List

From IQsimWiki

Jump to: navigation, search

XIQS Get Card List - Sim Card Management

Description
getXIQSCardList ( [ Long id_partition ] [, SimpleFilterObject SimpleFilter ] )
Get a list of Sim Card objects owned by this partition. In the case the current logged user is administrator, he gets the full list of all available Sim Card objects unless a 'partition id' parameter is specified
Parameters

[ Long id_partition ]

Partition Id

[ SimpleFilterObject SimpleFilter ]

Return Values
List List of Sim Card objects owned by this partition
Long id - SIM Card Id

String iccid - SIM card Integrated Circuit Card ID (ICCID)

String imsi - SIM Card International Mobile Subscriber Identifier (IMSI)

Until API 1.2.0:

String status - SIM Status ("INITIALIZING", "INITIALIZED", "REGISTERED_OUT_PAUSED", "REGISTERED", "ERR_SIM_PIN_FAIL", "ERR_SIM_PUK", "ERR_SIM_NOT_READY", "ERR_SIM_NEW_DETECTED", "NOT_REGISTERED", "ERR_FIRM_UPDATING", "ERR_FIRM_UPDATED", "ERR_FIRM_UPDATE_FAIL", "ERR_SIM_PIN_WAITING", "ERR_SIM_PIN_FAIL_WAITING")

Since API 1.3.0:

Long status - SIM Status String pincode - SIM PIN Code

String smscenter - SMS Service Center

Long id_group - Sim Group Id

Long id_device - GSM Device Id to which SIM card is assigned to

Long id_port - GSM Port Id to which SIM card is assigned to

Long id_rack - IRON SimRack Id

Integer rackslot - IRON SimRack slot

Integer rackport - IRON SimRack port

Long id_portgrp - GSM Port Group Id

Long mnc - GSM Operator MNC (Mobile Network Code)

Long mcc - GSM Operator MCC (Mobile Country Code)

Long deactivdate - Date (in seconds since 01/01/1970) when the SIM was deactivated

Long id_partition - Partition Id

String provider - GSM Operator name

String devname - GSM Device name

Long devport - GSM Device Port

String rackname - IRON Sim Rack name

String ppname - Price Plan name

Long elapsmin - Elapsed minutes

Long remainmin - Remaining Peak minutes

Long remainmin_off - Remaining Off Peak minutes

Long dailymin - Number of daily minutes

Long dailycalls - Number of daily calls

Long dailysms - Number of daily SMS

Long incallnb - Number of incomming calls

Long smsnb - Number of SMS

Long smsinnb - Number of incoming SMS

Long lastreload - Credit last modification

String lastsite - Last Device name where SIM was used

Long endsleepdate - End sleeping date

String slidnum - SLID number

String subscribernum - Subscriber number

Long creditcheck - Credit check mode (3 - Credit recharge will be performed on the next SIM port map)

Integer torefill - To be recharged flag

Integer toactiv - To be activated flag

Integer disabled - Disable SIM card flag

Long id_operator - GSM Operator Id

Integer rackstatus - IRON Sim Rack status (0 - unavailable, 1 - working)

Long id_pplan - Price Plan Id

Integer grpuseoffpeak - SIM Group use Off Peak flag

Long inclusivmin - Inclusive Peak minutes

Long inclusivmin_off - Inclusive Off Peak minutes

String contractbirthday - Postpaid Calendar Day (1-31); Indicate on which day of the month that SIM cards of the given price plan get new inclusive minutes

Long ppoutofcreditflag - Price Plan Peak Out-of-credit flag

Long ppoutofcreditflag_off - Price Plan Off Peak Out-of-credit flag

Long ppalertstep - Price Plan Alert step

Integer sleeping - Sleeping flag

Integer devicestatus - Device status (0 - device unreachable, 1 - device ready)

String comment - Comment

Long inclusivminbonus - Inclusive Bonus minutes

Long remainminbonus - Remaining Bonus minutes

Long inclusivsms_off - Inclusive number of Off Peak SMS

Long remainsms_off - Remaining number of Off Peak SMS

Long inclusivsmsbonus - Inclusive number of Bonus SMS

Long remainsmsbonus - Remaining number of Bonus SMS

Long remainsms - Remaining number of Peak SMS

Long concallnb - Number of connected calls

Long nonconcallnb - Number of non connected calls

Long callduraverage - Average call duration (seconds)

Long smssentnb - Number of sent SMS

Long inclusivsms - Inclusive number of Peak SMS

Long smsalertstep - SMS Alert Step

Long smsuseoffpeak - Use Off Peak SMS flag

Long lowdurnb - Number of low duration calls on a sim

String areacode - SIM Area Code

Long countrycode - Country Code

Long asr - ASR (%)

Integer dailylimitreached - Daily Limit Reached flag - calls 0x01, duration 0x02, sms 0x04, data 0x08

Long id_lastdevice -Last assigned gsm device

Integer islocale -Is physical SIM flag

Long follnoconxnb - Number of successive non connected calls

Long lastnoconxtype - Type of last non connected call (No carrier, Blacklist, ...)

Long follsmserrnb - Number of successive SMS sending fails

Long curnoconxnb - Number of successive non connected calls with type "lastnoconxtype"

String apn - Access Point Name for data connection

String apnuser - Username for data connectionn

String apnpass - Password for data connection

Long initialdate - Initial date for a credit

Long validitydate - End date for a credit

String pincode2 - New PIN code

String pukcode - PUK code

Integer unlimitedmin - Unlimited minutes flag

Integer unlimitedsms - Unlimited SMS flag

Long remainingdata - Remaining data

Long inclusivedata - Inclusive data

Long dailydata - Daily data

Long useddata - Used data

Integer protocoltype - Protocol Type (1:IPV4, 2:IPV6, 3:IPV4IPV6)

Integer roamingtype - Roaming Type (1:IPV4, 2:IPV6, 3:IPV4IPV6)

Integer authtype - Authentication Type (0:NONE, 1:PAP, 2:CHAP, 3:PAPCHAP)

Error Data structure ( Error Management )

Possible failure code returns
*ERR_SRV_INTERNAL (500) ERR_MSG_NO_DB
API 1.3.0 SIM Status details
The new Sim Status is an unsigned 32 bits value encoded on a high 16bits part for general status and a low 16bits part for detailed status or error codes.

In most high level language, the general status (hi) and detailed status (low) should be obtained as is:

 int iGeneralStatus = ( dwSimCardStatus >> 16  );
int iDetailedStatus = ( dwSimCardStatus & 0xFF );

The high part or general status is one of following values:

  • 0x00 = EMPTY : The SIM Status is unknown.
  • 0x01 = BEZEN2 : Sim is disabled and cannot be used from the system. Administrator must reactivate and makes the Sim available in order to use it.
  • 0x02 = BLACK_BLINK : Sim is being processed from Sim Manager to be allocated.
  • 0x03 = GREEN : Sim is currently registered to the mobile network.
  • 0x04 = GREEN_LIGHT : Sim has been virtualized and is ready to be used by the device.
  • 0x05 = GREEN_LIGHT_BLINK : Sim is being allocated to port. Information to connect to the Sim Rack and the Sim slot are being transferred to the device.
  • 0x06 = BLACK : Sim is idle and available for allocation.
  • 0x07 = WHITE : Sim has been recorded once in the database but is not present anymore in the system. It has been removed from Sim Rack.
  • 0x08 = EURO : Sim need to be recharged.
  • 0x09 = EXCLAMATION : Status is unknown as Sim Manager has lost connection from the device using the Sim.
  • 0x0A = EXCLAMATION_BLANC : Status is unknown as Sim Manager has lost connection from the Sim Rack and the device using the Sim.
  • 0x0B = YELLOW : Sim is currently in pause. Sim will be available after ending the pause.
  • 0x0C = ORANGE : Sim is currently registered to the mobile network and being in low credit.
  • 0x0D = RED : Sim is currently registered to the mobile network and using credit over the plan (postpaid Sim only).


The low part or status details is one of following values:

  • 0x00 = EMPTY : The SIM Status details is undefined
  • 0x01 = SIM_REGISTERED
  • 0x02 = SIM_ALLOCATED
  • 0x03 = SIM_NOTREGISTERED
  • 0x04 = SIM_WRONGPINCODE
  • 0x05 = SIM_PUKCODE
  • 0x06 = SIM_PINCODEWAITING
  • 0x07 = SIM_UNREACHABLERACK
  • 0x08 = SIM_TOBERECHARGED
  • 0x09 = SIM_ASSIGNING
  • 0x0A = LOW_DURATION_DETECTION
  • 0x0B = SIM_MAXASSIGNATION
  • 0x0C = SIM_MAXSUCCESSIVE
  • 0x0D = SIM_NOMORECREDIT
  • 0x0E = SIM_REFILLFAILED
  • 0x0F = SIM_TOBEACTIVATED
  • 0x10 = SIM_ACTIVATIONFAILED
  • 0x11 = SIM_CREDITSYNCMISMATCH
  • 0x12 = SIM_SLIDMISSING
  • 0x13 = SIM_SIMTRANSFER
  • 0x14 = SIM_PAUSED
  • 0x15 = SIM_MAXCONSSMSSENDING
  • 0x16 = SIM_CREDITDEAC
  • 0x17 = SIM_LOWDURATION
  • 0x18 = SIM_AREACODECTL
  • 0x19 = SIM_DEACTIVMANUAL
  • 0x1A = SIM_REMAIN_CALL_ALERT
  • 0x1B = SIM_REMAIN_CALLOFF_ALERT
  • 0x1C = SIM_REMAIN_CALLBONUS_ALERT
  • 0x1D = SIM_REMAIN_SMS_ALERT
  • 0x1E = SIM_REMAIN_SMSOFF_ALERT
  • 0x1F = SIM_REMAIN_SMSBONUS_ALERT
  • 0x20 = SIM_REMAIN_SMSCALL_ALERT
  • 0x21 = SIM_UNREADABLE_BY_RACK
  • 0x22 = SIM_VOUCHER_ALREADY_USED
  • 0x23 = SIM_INVALID_VOUCHER
  • 0x24 = SIM_ENUMERATING
  • 0x25 = SIM_SUCCESSIVE_DELIVERY_ERRORS
  • 0x26 = SIM_CREDIT_VALIDITY_EXPIRED
  • 0x27 = SIM_PIN_CHANGE_FAILED
  • 0x28 = SIM_PUK_FAILED
  • 0x29 = SIM_DAILY_SMS_ERROR_REACHED
See Also

updateXIQSCard

updateXIQSCardList

setPortXIQSCardList

freePortXIQSCardList

mapXIQSCard

unmapXIQSCard

deleteXIQSCard

deleteXIQSCardList


Example

[REQUEST]
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<command tid="fc723d03-f11d-4efd-aed3-43c9e1f34fd2" name="getXIQSCardList">
  <simplefilter>
    <start>0</start>
    <limit>250</limit>
    <DIR>DESC</DIR>
    <SORT>iccid</SORT>
  </simplefilter>
</command>

[ANSWER (OK)]
<?xml version="1.0" encoding="ISO-8859-1"?>
<event type="return" tid="fc723d03-f11d-4efd-aed3-43c9e1f34fd2">
  <meta-data>
    <meta-value>
      <name>start</name>
      <pos>1</pos>
    </meta-value>
    <meta-value>
      <name>count</name>
      <pos>2</pos>
    </meta-value>
    <meta-value>
      <name>total</name>
      <pos>3</pos>
    </meta-value>
    <card-meta>
      <meta-value>
        <name>id</name>
        <pos>1</pos>
      </meta-value>
      <meta-value>
        <name>iccid</name>
        <pos>2</pos>
      </meta-value>
      <meta-value>
        <name>imsi</name>
        <pos>3</pos>
      </meta-value>
      <meta-value>
        <name>status</name>
        <pos>4</pos>
      </meta-value>
      <meta-value>
        <name>pincode</name>
        <pos>5</pos>
      </meta-value>
      <meta-value>
        <name>smscenter</name>
        <pos>6</pos>
      </meta-value>
      <meta-value>
        <name>id_group</name>
        <pos>7</pos>
      </meta-value>
      <meta-value>
        <name>id_device</name>
        <pos>8</pos>
      </meta-value>
      <meta-value>
        <name>id_port</name>
        <pos>9</pos>
      </meta-value>
      <meta-value>
        <name>id_rack</name>
        <pos>10</pos>
      </meta-value>
      <meta-value>
        <name>rackslot</name>
        <pos>11</pos>
      </meta-value>
      <meta-value>
        <name>rackport</name>
        <pos>12</pos>
      </meta-value>
      <meta-value>
        <name>id_portgrp</name>
        <pos>13</pos>
      </meta-value>
      <meta-value>
        <name>mnc</name>
        <pos>14</pos>
      </meta-value>
      <meta-value>
        <name>mcc</name>
        <pos>15</pos>
      </meta-value>
      <meta-value>
        <name>deactivdate</name>
        <pos>16</pos>
      </meta-value>
      <meta-value>
        <name>id_partition</name>
        <pos>17</pos>
      </meta-value>
      <meta-value>
        <name>provider</name>
        <pos>18</pos>
      </meta-value>
      <meta-value>
        <name>devname</name>
        <pos>19</pos>
      </meta-value>
      <meta-value>
        <name>devport</name>
        <pos>20</pos>
      </meta-value>
      <meta-value>
        <name>grpname</name>
        <pos>21</pos>
      </meta-value>
      <meta-value>
        <name>rackname</name>
        <pos>22</pos>
      </meta-value>
      <meta-value>
        <name>ppname</name>
        <pos>23</pos>
      </meta-value>
      <meta-value>
        <name>elapsmin</name>
        <pos>24</pos>
      </meta-value>
      <meta-value>
        <name>remainmin</name>
        <pos>25</pos>
      </meta-value>
      <meta-value>
        <name>remainmin_off</name>
        <pos>26</pos>
      </meta-value>
      <meta-value>
        <name>dailymin</name>
        <pos>27</pos>
      </meta-value>
      <meta-value>
        <name>dailycalls</name>
        <pos>28</pos>
      </meta-value>
      <meta-value>
        <name>dailysms</name>
        <pos>29</pos>
      </meta-value>
      <meta-value>
        <name>incallnb</name>
        <pos>30</pos>
      </meta-value>
      <meta-value>
        <name>smsnb</name>
        <pos>31</pos>
      </meta-value>
      <meta-value>
        <name>smsinnb</name>
        <pos>32</pos>
      </meta-value>
      <meta-value>
        <name>lastreload</name>
        <pos>33</pos>
      </meta-value>
      <meta-value>
        <name>lastsite</name>
        <pos>34</pos>
      </meta-value>
      <meta-value>
        <name>endsleepdate</name>
        <pos>35</pos>
      </meta-value>
      <meta-value>
        <name>slidnum</name>
        <pos>36</pos>
      </meta-value>
      <meta-value>
        <name>subscribernum</name>
        <pos>37</pos>
      </meta-value>
      <meta-value>
        <name>creditcheck</name>
        <pos>38</pos>
      </meta-value>
      <meta-value>
        <name>torefill</name>
        <pos>39</pos>
      </meta-value>
      <meta-value>
        <name>toactiv</name>
        <pos>40</pos>
      </meta-value>
      <meta-value>
        <name>disabled</name>
        <pos>41</pos>
      </meta-value>
      <meta-value>
        <name>id_operator</name>
        <pos>42</pos>
      </meta-value>
      <meta-value>
        <name>rackstatus</name>
        <pos>43</pos>
      </meta-value>
      <meta-value>
        <name>id_pplan</name>
        <pos>44</pos>
      </meta-value>
      <meta-value>
        <name>grpuseoffpeak</name>
        <pos>45</pos>
      </meta-value>
      <meta-value>
        <name>inclusivmin</name>
        <pos>46</pos>
      </meta-value>
      <meta-value>
        <name>inclusivmin_off</name>
        <pos>47</pos>
      </meta-value>
      <meta-value>
        <name>contractbirthday</name>
        <pos>48</pos>
      </meta-value>
      <meta-value>
        <name>ppoutofcreditflag</name>
        <pos>49</pos>
      </meta-value>
      <meta-value>
        <name>ppoutofcreditflag_off</name>
        <pos>50</pos>
      </meta-value>
      <meta-value>
        <name>ppalertstep</name>
        <pos>51</pos>
      </meta-value>
      <meta-value>
        <name>sleeping</name>
        <pos>52</pos>
      </meta-value>
      <meta-value>
        <name>devicestatus</name>
        <pos>53</pos>
      </meta-value>
      <meta-value>
        <name>comment</name>
        <pos>54</pos>
      </meta-value>
      <meta-value>
        <name>inclusivminbonus</name>
        <pos>55</pos>
      </meta-value>
      <meta-value>
        <name>remainminbonus</name>
        <pos>56</pos>
      </meta-value>
      <meta-value>
        <name>inclusivsms_off</name>
        <pos>57</pos>
      </meta-value>
      <meta-value>
        <name>remainsms_off</name>
        <pos>58</pos>
      </meta-value>
      <meta-value>
        <name>inclusivsmsbonus</name>
        <pos>59</pos>
      </meta-value>
      <meta-value>
        <name>remainsmsbonus</name>
        <pos>60</pos>
      </meta-value>
      <meta-value>
        <name>remainsms</name>
        <pos>61</pos>
      </meta-value>
      <meta-value>
        <name>concallnb</name>
        <pos>62</pos>
      </meta-value>
      <meta-value>
        <name>nonconcallnb</name>
        <pos>63</pos>
      </meta-value>
      <meta-value>
        <name>callduraverage</name>
        <pos>64</pos>
      </meta-value>
      <meta-value>
        <name>smssentnb</name>
        <pos>65</pos>
      </meta-value>
      <meta-value>
        <name>inclusivsms</name>
        <pos>66</pos>
      </meta-value>
      <meta-value>
        <name>smsuseoffpeak</name>
        <pos>67</pos>
      </meta-value>
    </card-meta>
  </meta-data>
  <param type="long">0</param>
  <param type="long">250</param>
  <param type="long">2</param>
  <card>
    <param type="long">100005</param>
    <param type="string">8933201910035670406</param>
    <param type="string">208201903567040</param>
    <param type="string">196609</param>
    <param type="string">0000</param>
    <param type="string">+33660003000</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">1</param>
    <param type="integer">1</param>
    <param type="integer">5</param>
    <param type="long">0</param>
    <param type="long">201</param>
    <param type="long">208</param>
    <param type="long">1308263310</param>
    <param type="long">2</param>
    <param type="string">Bouygues Telecom</param>
    <param type="string"></param>
    <param type="long">0</param>
    <param type="string"></param>
    <param type="string">SimRack1</param>
    <param type="string"></param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="string"></param>
    <param type="long">0</param>
    <param type="string"></param>
    <param type="string"></param>
    <param type="long">0</param>
    <param type="integer">0</param>
    <param type="integer">0</param>
    <param type="integer">0</param>
    <param type="long">20820</param>
    <param type="integer">1</param>
    <param type="long">0</param>
    <param type="integer">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="string">16</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="integer">0</param>
    <param type="integer">0</param>
    <param type="string"></param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
  </card>
  <card>
    <param type="long">100006</param>
    <param type="string">8933201910034886748</param>
    <param type="string">208201903488674</param>
    <param type="string">INITIALIZING</param>
    <param type="string">0000</param>
    <param type="string">+33660003000</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">1</param>
    <param type="integer">1</param>
    <param type="integer">6</param>
    <param type="long">0</param>
    <param type="long">201</param>
    <param type="long">208</param>
    <param type="long">1308263310</param>
    <param type="long">2</param>
    <param type="string">Bouygues Telecom</param>
    <param type="string"></param>
    <param type="long">0</param>
    <param type="string"></param>
    <param type="string">SimRack1</param>
    <param type="string"></param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="string"></param>
    <param type="long">0</param>
    <param type="string"></param>
    <param type="string"></param>
    <param type="long">0</param>
    <param type="integer">0</param>
    <param type="integer">0</param>
    <param type="integer">0</param>
    <param type="long">20820</param>
    <param type="integer">1</param>
    <param type="long">0</param>
    <param type="integer">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="string">16</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="integer">0</param>
    <param type="integer">0</param>
    <param type="string"></param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
    <param type="long">0</param>
  </card>
</event>

[ANSWER (Error)]
<?xml version="1.0" encoding="ISO-8859-1"?>
<event type="error">
  <meta-data>
    <meta-value>
      <name>err_code</name>
      <pos>1</pos>
    </meta-value>
    <meta-value>
      <name>err_desc</name>
      <pos>2</pos>
    </meta-value>
  </meta-data>
  <param type="integer">500</param>
  <param type="string"> err.db.connection.failed</param>
</event>

Personal tools
Namespaces
Variants
Views
Actions
Navigation
XIQS XML Protocol
XIQS Framework Libraries
XIQS Command List